QIcon Class

メンバ関数ドキュメント

これはオーバーロードされた関数である。

current icon theme のicon に対応するQIcon を返す。

現在のテーマがicon に対応するアイコンを提供していない場合、fallback icon theme が参照され、その後にfallback icon search path のスタンドアロンアイコンファイルが参照されます。 最後に、プラットフォームのネイティブアイコンライブラリが参照されます。

アイコンが見つからず、fallback が提供された場合、fallback が返される。これは、現在のアイコンテーマとフォールバックパスのセットが、 要求されたアイコンをサポートしているかどうかに関係なく、 保証されたフォールバックを提供するのに便利である。

アイコンが見つからず、fallback も提供されない場合、デフォルトで構築された空のQIcon が返されます。

この関数は Qt 6.7 で導入されました。

[noexcept] QIcon::QIcon()

NULLアイコンを構築します。

[explicit] QIcon::QIcon(QIconEngine *engine)

特定のアイコンengine を持つアイコンを作成します。アイコンはエンジンの所有権を持ちます。

QIcon::QIcon(const QPixmap &pixmap)

pixmap からアイコンを構築します。

[explicit] QIcon::QIcon(const QString &fileName)

指定されたfileName のファイルからアイコンを構築します。フ ァ イ ルは必要に応じて読み込まれます。

fileName に相対パ ス （た と えば フ ァ イ ル名のみ） が含まれてい る 場合は、 関連す る フ ァ イ ルが実行時の作業デ ィ レ ク ト リ か ら の相対パスで見つか る 必要があ り ます。

ファイル名は、ディスク上の実際のファイルまたはアプリケーションの組み込みリソースのいずれかを参照することができる。アプリケーションの実行ファイルに画像やその他のリソース・ファイルを埋め込む方法の詳細については、リソース・システムの概要を参照してください。

サポートされているファイル・フォーマットの完全なリストを取得するには、QImageReader::supportedImageFormats() およびQImageWriter::supportedImageFormats() 関数を使用してください。

QIcon::QIcon(const QIcon &other)

otherこれは非常に高速です。

[noexcept] QIcon::QIcon(QIcon &&other)

Move-QIconインスタンスを構築し、other が指していたのと同じオブジェクトを指すようにします。

[noexcept] QIcon::~QIcon()

アイコンを破棄します。

QSize QIcon::actualSize(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

要求されたsize,mode,state のアイコンの実際のサイズを返します。結果は要求されたサイズより小さくなることはあるが、大きくなることはない。返されるサイズは、デバイスに依存しないピクセル単位である(これは高dpi pixmapに関連する)。

pixmap() およびpaint()も参照 。

void QIcon::addFile(const QString &fileName, const QSize &size = QSize(), QIcon::Mode mode = Normal, QIcon::State state = Off)

size 、mode 、state の特殊化として、与えられたfileName のファイルから画像をアイコンに追加します。ファイルは必要に応じて読み込まれます。注意: カスタムアイコンエンジンは、追加された pixmap を自由に無視できます。

fileName に相対パス(例えばファイル名のみ)が含まれている場合、関連ファイルはランタイムの作業ディレクトリからの相対パスで見つけられなければならない。

ファイル名は、ディスク上の実際のファイルを参照することも、アプリケーションの組み込みリソースの1つを参照することもできます。アプリケーションの実行ファイルに画像やその他のリソース・ファイルを埋め込む方法の詳細については、リソース・システムの概要を参照してください。

サポートされているファイル・フォーマットの完全なリストを取得するには、QImageReader::supportedImageFormats() とQImageWriter::supportedImageFormats() 関数を使用してください。

画像の高解像度バージョンが存在する場合（ベース名の接尾辞@2x で識別）、自動的に読み込まれ、デバイスのピクセル比が2 に設定された状態で追加されます。これは、環境変数QT_HIGHDPI_DISABLE_2X_IMAGE_LOADING を設定することで無効にすることができます（QImageReader を参照）。

addPixmap() およびQPixmap::devicePixelRatio()も参照して ください。

void QIcon::addPixmap(const QPixmap &pixmap, QIcon::Mode mode = Normal, QIcon::State state = Off)

mode とstate の特殊化として、アイコンにpixmap を追加する。

カスタムアイコンエンジンは、追加された pixmap を自由に無視できる。

addFile()も参照 。

QList<QSize> QIcon::availableSizes(QIcon::Mode mode = Normal, QIcon::State state = Off) const

指定されたmode およびstate で利用可能なアイコンサイズの一覧を返します。

qint64 QIcon::cacheKey() const

このQIcon オブジェクトの内容を識別する番号を返す。異なるQIcon オブジェクトが同じコンテンツを参照する場合、同じキーを持つことができます。

cacheKey() は、addPixmap() またはaddFile() によってアイコンが変更されると変更されます。

キャッシュ・キーは、主にキャッシュと組み合わせて使用すると便利です。

QPixmap::cacheKey()も参照 。

[static] QStringList QIcon::fallbackSearchPaths()

アイコンのフォールバック検索パスを返します。

フォールバック検索パスは、current icon theme またはfallback icon theme でアイコン検索の結果が得られなかった場合に、スタンドアロンのアイコンファイルに対して参照される。

設定されていない場合、予備検索パスはプラットフォームによって定義される。

setFallbackSearchPaths() およびthemeSearchPaths()も参照 。

[static] QString QIcon::fallbackThemeName()

fallbackアイコンテーマの名前を返します。

設定されていない場合、フォールバック・アイコン・テーマはプラットフォームによって定義されます。

setFallbackThemeName() およびthemeName()も参照 。

[static] QIcon QIcon::fromTheme(const QString &name)

current icon theme のname に対応するQIcon を返す。

現在のテーマがname に対応するアイコンを提供していない場合、fallback icon theme が参照され、その後にfallback icon search path のスタンドアロンアイコンファイルが参照される。 最後に、プラットフォームのネイティブアイコンライブラリが参照される。

現在のアイコンテーマからアイコンを取得する：

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo);

setThemeName() でicon theme が明示的に設定されていない場合、プラットフォームで 定義されたアイコンテーマが使用される。

themeName(),fallbackThemeName(),setThemeName(),themeSearchPaths(),fallbackSearchPaths() およびFreedesktop IconNamingSpecificationも参照 。

[static] QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback)

これはオーバーロードされた関数です。

current icon theme のname に対応するQIcon を返します。

現在のテーマがname に対応するアイコンを提供していない場合、fallback icon theme が参照され、その後にfallback icon search path のスタンドアロンアイコンファイルが参照される。 最後に、プラットフォームのネイティブアイコンライブラリが参照される。

アイコンが見つからなければfallback が返される。

これは、現在のアイコンテーマとフォールバックパスのセットが要求されたアイコンをサポートしているかどうかに関係なく、保証されたフォールバックを提供するのに便利です。

例えば

QIcon undoicon = QIcon::fromTheme(QIcon::ThemeIcon::EditUndo, QIcon(":/undo.png"));

fallbackThemeName() およびfallbackSearchPaths()も参照 。

[static] bool QIcon::hasThemeIcon(const QString &name)

fromTheme() で説明したように、現在のアイコンテーマまたはフォールバックのいずれかにname で使用可能なアイコンがある場合はtrue を返し、そうでない場合はfalse を返す。

themeSearchPaths()、fromTheme()、setThemeName()も参照 。

[static, since 6.7] bool QIcon::hasThemeIcon(QIcon::ThemeIcon icon)

これはオーバーロードされた関数である。

fromTheme() で説明されているように、現在のアイコンテーマまたはフォールバックのいずれかにicon で利用可能なアイコンがある場合はtrue を返し、そうでない場合はfalse を返します。

この関数はQt 6.7で導入されました。

fromTheme()も参照してください 。

bool QIcon::isMask() const

このアイコンがマスク画像としてマークされている場合はtrue を返します。プラットフォームによっては、マスクアイコンのレンダリングが異なります（例えば、macOSのメニューアイコンなど）。

setIsMask()も参照 。

bool QIcon::isNull() const

アイコンが空の場合はtrue を返し、そうでない場合はfalse を返す。

アイコンは、pixmapもファイル名も持たない場合は空である。

注意: 空でないアイコンであっても、ファイルが存在しない場合や読み込めない場合など、有効な pixmap を作成できないことがあります。

QString QIcon::name() const

アイコンの作成に使用された名前があれば、それを返します。

アイコンの作成方法によっては、アイコンに関連付けられた名前がある場合があります。これは、fromTheme() で作成されたアイコンの場合である。

fromTheme() およびQIconEngine::iconName()も参照 。

void QIcon::paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

painter を使用して、指定されたalignment 、必須のmode 、およびstate を持つアイコンを、矩形rect にペイントします。

actualSize() およびpixmap() も参照 。

void QIcon::paint(QPainter *painter, int x, int y, int w, int h, Qt::Alignment alignment = Qt::AlignCenter, QIcon::Mode mode = Normal, QIcon::State state = Off) const

これはオーバーロードされた関数です。

アイコンを矩形QRect(x,y,w,h) にペイントします。

QPixmap QIcon::pixmap(const QSize &size, QIcon::Mode mode = Normal, QIcon::State state = Off) const

要求 さ れたsize,mode,state を持つ pixmap を返 し 、 必要に応 じ て生成 し ます。返 さ れ る pixmap のデバ イ ス ピ ク セル比が 1 よ り 大 き く な ら ない限 り 、 pixmap は要求 よ り 小 さ く な る こ と があ り ますが、 それ よ り 大 き く な る こ と はあ り ません。

actualSize() およびpaint()も参照 。

QPixmap QIcon::pixmap(int extent, QIcon::Mode mode = Normal, QIcon::State state = Off) const

これはオーバーロードされた関数である。

サイズQSize(extent,extent) の pixmap を返す。返される pixmap のデバイスピクセル比が 1 より大きくない限り、 pixmap は要求されたサイズより小さくなることはあっても、大きくなることはありません。

[since 6.0] QPixmap QIcon::pixmap(const QSize &size, qreal devicePixelRatio, QIcon::Mode mode = Normal, QIcon::State state = Off) const

これはオーバーロードされた関数です。

要求されたsize 、devicePixelRatio 、mode 、state を持つ pixmap を返し、 必要であれば、与えられたmode とstate を持つ pixmap を生成します。返される pixmap のデバイスピクセル比が 1 より大きくない限り、pixmap は要求された値より小さくなることはありますが、大きくなることはありません。

この関数は Qt 6.0 で導入されました。

actualSize() とpaint()も参照してください 。

QPixmap QIcon::pixmap(int w, int h, QIcon::Mode mode = Normal, QIcon::State state = Off) const

これはオーバーロードされた関数です。

サイズQSize(w,h) の pixmap を返します。返 さ れ る pixmap のデバ イ ス ピ ク セル比が 1 よ り 大 き く な ら ない限 り 、 pixmap は要求 よ り 小 さ く な る こ と があ り ますが、 それ よ り 大 き く な る こ と はあ り ません。

[static] void QIcon::setFallbackSearchPaths(const QStringList &paths)

アイコンの予備検索パスをpaths に設定する。

フォールバック検索パスは、current icon theme またはfallback icon theme でアイコン検索の結果が得られない場合に、スタンドアロンアイコンファイルに対して参照される。

例えば

QIcon::setFallbackSearchPaths(QIcon::fallbackSearchPaths() << "my/search/path");

fallbackSearchPaths() およびsetThemeSearchPaths()も参照 。

[static] void QIcon::setFallbackThemeName(const QString &name)

予備アイコンテーマをname に設定する。

フォールバック・アイコン・テーマは、current icon theme で提供されないアイコンや、current icon theme が存在しない場合に参照される。

name は、setThemeName() でドキュメント化されているのと同じフォーマットで theme に対応していなければならず、themeSearchPaths() で検索される。

fallbackThemeName （）、themeSearchPaths （）、themeName （）も参照 。

void QIcon::setIsMask(bool isMask)

このアイコンがマスク画像であることを示す(booleanisMask)。

isMask()も参照のこと 。

[static] void QIcon::setThemeName(const QString &name)

現在のアイコンテーマをname に設定する。

このテーマはthemeSearchPaths() で検索されます。

現時点でサポートされているアイコンテーマの形式はFreedesktop Icon Theme Specification のみです。name は、その内容を記述したindex.theme ファイルを含む themeSearchPath() のディレクトリ名に対応する必要があります。

themeSearchPaths()、themeName()、Freedesktop IconThemeSpecificationも参照 。

[static] void QIcon::setThemeSearchPaths(const QStringList &paths)

アイコンテーマの検索パスをpaths に設定する。

paths の内容は、setThemeName() で文書化されているテーマフォーマットに従うべきである。

themeSearchPaths()、fromTheme()、setThemeName()も参照 。

[noexcept] void QIcon::swap(QIcon &other)

アイコンother をこのアイコンと交換する。この操作は非常に高速で、失敗することはない。

[static] QString QIcon::themeName()

現在のアイコンテーマの名前を返します。

設定されていない場合、現在のアイコンテーマはプラットフォームによって定義されます。

setThemeName(),themeSearchPaths(),fromTheme(),hasThemeIcon()も参照 。

[static] QStringList QIcon::themeSearchPaths()

アイコンテーマの検索パスを返します。

デフォルトの検索パスはプラットフォームによって定義されます。すべてのプラットフォームは、フォールバックとしてリソースディレクトリ:\icons も持っています。

setThemeSearchPaths()、fromTheme()、setThemeName()も参照 。

QVariant QIcon::operator QVariant() const

QVariant としてアイコンを返す。

[noexcept] QIcon &QIcon::operator=(QIcon &&other)

Move-other をこのQIcon インスタンスに割り当てます。

QIcon &QIcon::operator=(const QIcon &other)

other アイコンをこのアイコンに割り当て、このアイコンへの参照を返します。