QtDockTile-クロスプラットフォームでのドックの使用！

デスクトップ開発の現在の傾向を考慮すると、ドックのアイデアがますます普及しているという事実に注意を払わないことは困難です。 この原則には、少なくとも3つの一般的な実装があります。Makovskyドック、windiws 7のタスクバー、Unityのランチャーです。 アイコンタスクもkde 4.8でこのリストに追加されます。

つまり、この多様性すべてに対応するユニバーサルライブラリを作成する必要があります。

qtdocktileに会う

すべてのドックに共通

まず、すべてのドックに共通する機能のリストを強調表示する必要があります。

1. バッジ
2. 進捗インジケータ
3. メニュー
4. アラーム

この機能はすべて基本的なものであり、7、まこし、ubuntで何らかの形でサポートされています。 それに基づいて、ベースのqtdocktile APIが構築され、すべてのプラットフォーム依存の拡張機能がライブラリの開発時に追加され、必要なくなります。

図書館の建築

最大の柔軟性と拡張性のために、特定の各ドックの実装は通常のQtプラグインであると決定しました-これにより、ライブラリ全体を再コンパイルせずに新しいAPIのサポートを追加でき、いずれかの実装を使用できない場合、プラグインは起動しません。 プラグインは、特別なシングルトンマネージャーによってロードされます。 各プラグインは、この環境で動作できるかどうかをマネージャーに通知します。その結果、マネージャーは、この環境で動作可能なプラグインでのみ必要なメソッドを呼び出すことができます。

ユーザーは、マネージャーのラッパーである単純なQtDockTileクラスを使用します。 その結果、QtDockTileインスタンスをいくつでも安全に作成できます-それらはドックを中断しません。

ドックメニューには、通常のQtshnoe QMenuが使用されます。 このプラットフォームまたはそのプラットフォームが設​​定する制限のみを覚えておく必要があります。

サンプルライブラリの使用

m_tile->setMenu(ui->menu); connect(ui->pushButton, SIGNAL(clicked()), m_tile, SLOT(alert())); connect(ui->lineEdit, SIGNAL(textChanged(QString)), m_tile, SLOT(setBadge(QString))); connect(ui->horizontalSlider, SIGNAL(valueChanged(int)), m_tile, SLOT(setProgress(int)));
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ご覧のとおり、非常に簡単です！ しかし、単純なAPIの作成は問題の半分であり、すべてのプラットフォームのサポートを実装する必要があります。



注意！ さらに、多くの技術的な詳細がありますが、それらに興味がない場合は、すぐに結論を読むことができます。

Unityのプラグイン実装

奇妙なことに、Unityの場合、最短で簡潔な実装が行われました。 すべてのAPIは、非常に単純なdbusメッセージの送信に基づいています。

 void UnityLauncher::sendMessage(const QVariantMap &map) { QDBusMessage message = QDBusMessage::createSignal(appUri(), "com.canonical.Unity.LauncherEntry", "Update"); QVariantList args; args << appDesktopUri() << map; message.setArguments(args); if (!QDBusConnection::sessionBus().send(message)) qWarning("Unable to send message"); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

appUriはアプリケーションの一意の名前です。この実装では、プロセスの名前と単純に一致し、appDesktopUriはapplication：//$appUri.desktopというフォームのエントリです。

バッジの値を変更するには、次のメッセージを送信するだけで十分です。

  QVariantMap map; map.insert(QLatin1String("count"), count); map.insert(QLatin1String("count-visible"), count > 0); sendMessage(map);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

同様に、プログレスインジケーターとシグナリングについても、メニューはもう少し興味深いものです。appUriとQMenuへのポインターを渡すことで作成するときにDBusMenuExporterクラスを使用する必要があります。 これがすべてのAPIです。次に、制限をリストします。

Unity Launcher APIの制限

1. バッジはデジタルのみであり、0より大きいのみです。それ以外の場合、0が表示されます。
2. エクスポートされたメニューにはサブメニューが表示されないため、サブメニューは避けたほうがよいでしょう。
3. メニューもappmenuにエクスポートされる場合、ドックに表示されません
4. DBusMenuExporterの実装にはバグがあり、その結果、メニューのチェック状態が反転します

最後に、APIを機能させるには、アプリケーションの/usr/share/applications.desktopにアイコンが必要です。 ところで、Unity APIを使用すると、アプリケーションが実行されていないときに機能する永続的なアイテムをメニューに追加できます。これは次のようになります。

 X-Ayatana-Desktop-Shortcuts=NewWindow; [NewWindow Shortcut Group] Name=Open a New Window Name[ast]=Abrir una ventana nueva Name[bn]=Abrir una ventana nueva Name[ca]=Obre una finestra nova Name[da]=Åbn et nyt vindue Name[de]=Ein neues Fenster öffnen Name[es]=Abrir una ventana nueva Name[fi]=Avaa uusi ikkuna Name[fr]=Ouvrir une nouvelle fenêtre Name[gl]=Abrir unha nova xanela Name[he]=פתיחת חלון חדש Name[hr]=Otvori novi prozor Name[hu]=Új ablak nyitása Name[it]=Apri una nuova finestra Name[ja]=新しいウィンドウを開くName[ku]=Paceyeke nû veke Name[lt]=Atverti naują langą Name[nl]=Nieuw venster openen Name[ro]=Deschide o fereastră nouă Name[ru]=   Name[sv]=Öppna ett nytt fönster Name[ug]=يېڭى كۆزنەك ئېچىش Name[uk]=і  і Name[zh_CN]=新建窗口Name[zh_TW]=開啟新視窗Exec=firefox -new-window TargetEnvironment=Unity
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

また、いくつかのスクリーンショットのスナック用：

ユニティ：



KDE（アイコンタスク）：





プラグインを作成するとき、 QutIMにTorkveの作業を使用しました。

Macos Xのプラグイン実装

また、特別な困難はありませんでした。Qtにメニューをエクスポートするための特別な方法がすでにあります。それについては、 ここで多くのことが言われています。

バッジはCocoaを使用して簡単にインストールできます。QStringをNSStringに変換し、メッセージをドックに送信し、メモリをクリアするだけで済みます。

  const char *utf8String = badge.toUtf8().constData(); NSString *cocoaString = [[NSString alloc] initWithUTF8String:utf8String]; [[NSApp dockTile] setBadgeLabel:cocoaString]; [cocoaString release];
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

進行状況インジケーターを作成するのが少し難しくなりました。DockAPIには組み込みのメソッドはありませんが、Dockアイコンに画像を描画するメソッドがあります。 あまり気にしないために、LGPLライセンスは耳をそそりながらそのような気絶を許可しているので、QtCreatorからインディケータの実装を取りました。

スクリーンショット

Windows 7タスクバーの実装

そして最後に、最もおいしい！ 他のシステムでプラグインの作成プロセスが多少スムーズになった場合、最も人気のあるデスクトップOSの場合、すべてがクラウドレスではないことが判明したため、ビルゲイツ、スティーブバルマー、さまざまなレーキを慎重にレイアウトした無名のプログラマーなど、さまざまな悪い言葉で自分自身を覚えなければなりませんでした！ 執筆の過程で、フレーズは死ななければなりません、wtfなどは古き良きウィンドスまで何度も発生しました。

wchar_t *の代わりにLPCSTRのような奇妙な読みにくい型があり、すべてのフィールドにハンガリー語の表記法があり、ひどくひどいCOMがあります。つまり、コードスタイルはひどいです。 また、ABIには問題があり、その結果、MSコンパイラによってコンパイルされたC ++ライブラリをminGWによってコンパイルされたコードにリンクすることは不可能です。 さて、松葉杖に行かなければならなかったため、API自体はやや奇妙です。 さらに、ジャンプリストの例には、ATLライブラリの使用が含まれています。ATLライブラリは、有料のスタジオでのみ利用可能であり、この理由から私たちには適していません。

ABIの問題を解決するために、 dtfと私は、将来どのコンパイラからでも動的にリンクできるように、タスクバーのCOM APIに最小限のCラッパーを作成することにしました。

APIは非常にシンプルであることが判明しました。ラッパー自体はQtに依存せず、どこからでも使用できますが、完全にwinAPIのスタイルではありません。

 ... EXPORT void setApplicationId(const wchar_t *appId); EXPORT void setOverlayIcon(HWND winId, HICON icon, wchar_t *description = 0); EXPORT void clearOverlayIcon(HWND winId); EXPORT void setProgressValue(HWND winId, int percents); EXPORT void setProgressState(HWND winId, ProgressState state); ...
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

私は最も単純なものから始めました：進行状況インジケーターを作成することにしました。そのコードは同志dtfによって既に書かれていたので、転送に特別な困難はありませんでした。

 //    static ITaskbarList3 *windowsTaskBar() { ITaskbarList3 *taskbar; if(S_OK != CoCreateInstance(CLSID_TaskbarList, 0, CLSCTX_INPROC_SERVER, IID_ITaskbarList3, (void**)&taskbar)) return 0; return taskbar; } ... //   void setProgressValue(HWND winId, int progress) { ITaskbarList3 *taskbar = windowsTaskBar(); if (!taskbar) return; taskbar->HrInit(); taskbar->SetProgressValue(winId, progress, 100); taskbar->SetProgressState(winId, progress ? TBPF_NORMAL : TBPF_NOPROGRESS); taskbar->Release(); } //    void setProgressState(HWND winId, ProgressState state) { TBPFLAG flags; ITaskbarList3 *taskbar = windowsTaskBar(); if (!taskbar) return; taskbar->HrInit(); switch (state) { default: case ProgressStateNone : flags = TBPF_NOPROGRESS; break; case ProgressStateNormal : flags = TBPF_NORMAL; break; case ProgressStatePaused : flags = TBPF_PAUSED; break; case ProgressStateError : flags = TBPF_ERROR; break; case ProgressStateIndeterminate : flags = TBPF_INDETERMINATE; break; } taskbar->SetProgressState(winId, flags); taskbar->Release(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

setOverlayIconメソッドを使用してバッジを実装し、アイコン自体を描画し、Qtを使用してHICONに変換しました

 QPixmap WindowsTaskBar::createBadge(const QString &badge) const { QPixmap pixmap(overlayIconSize()); QRect rect = pixmap.rect(); rect.adjust(1, 1, -1, -1); pixmap.fill(Qt::transparent); QPainter painter(&pixmap); painter.setRenderHint(QPainter::Antialiasing); QPalette palette = window()->palette(); painter.setBrush(palette.toolTipBase()); QPen pen = painter.pen(); pen.setColor(palette.color(QPalette::ToolTipText)); painter.setPen(pen); QString label = QFontMetrics(painter.font()).elidedText(badge, Qt::ElideMiddle, rect.width()); painter.drawRoundedRect(rect, 5, 5); painter.drawText(rect, Qt::AlignCenter | Qt::TextSingleLine, label); return pixmap; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その結果、バッジに挿入できるのは2文字のみです。 アイコンのサイズはQStyle :: pixelMetricsを介して設定されます。overlayIconの他の実装は16x16のアイコンを描画するだけで、dpiを気にしないため、モニターのアイコンはぼやけていることがわかりました。

そして今、最も興味深いのはジャンプリストの実装です。 それは古いビリーが不在で彼に宛てた多くの愛情深い言葉を聞いた場所です！

試験番号1-APIの制限に基づくQActionのシリアル化

各アクションには、名前、アクションをクリックしたときに実行されるコマンド、およびオプションでico形式のアイコンへのパスと説明があります。 さらに、これらはすべてワイドワイド文字列の形式で送信する必要があり、したがって、それらの寿命を独立して監視する必要があります。 もちろん、コールバックを何らかの形で整理する必要がありますが、これも明らかではありません。QActionでトリガーメソッドを呼び出す必要がありますが、これも一見シンプルに見えません。

このコンテンツの構造の配列をシステムラッパーに転送します。

 struct ActionInfo { const char *id; wchar_t *name; wchar_t *description; wchar_t *iconPath; ActionType type; void *data; //    -                 . }; typedef void (*ActionInvoker)(void*); //  ,      void *data
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、void *データの秘密を明らかにしましょう。

 typedef QVector<ActionInfo> ActionInfoList; //   ++,          typedef QVector<wchar_t> WCharArray; //  wchar_t * static WCharArray toWCharArray(const QString &str) { WCharArray array(str.length() + 1); str.toWCharArray(array.data()); return array; } struct Data { Data(QAction *action) : action(action), icon(action->icon()), id(QUuid::createUuid().toByteArray()), name(toWCharArray(action->text())), description(toWCharArray(action->toolTip())), iconPath(toWCharArray(icon.filePath())) { } QWeakPointer<QAction> action; TemporaryIcon icon; QByteArray id; WCharArray name; WCharArray description; WCharArray iconPath; }; void invokeQAction(void *pointer) { Data *data = reinterpret_cast<Data*>(pointer); if (data->action) { qDebug() << data->action.data(); data->action.data()->trigger(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このようなアクションのシリアル化を次に示します。 手動での新規作成と削除の数を最小限にしようとしました-すべてが自動的に行われます。 あなたの髪が滑らかで絹のようになることを保証するのはこのアプローチです！



次に、プラットフォームの制限を思い出して、どのアクションをシリアル化でき、どのアクションを無視するのが良いかを理解しましょう。 そのため、ジャンプリストにはサブメニューはありません。無効化されチェック可能なアイテムはありません。アイテムの総数は20に制限されています。 しかし、セパレーターがあり、次のような結果になります。

  if (!action->menu() && action->isVisible() && action->isEnabled() && !action->isCheckable()) list.append(serialize(action)); ... ActionInfo JumpListsMenuExporterPrivate::serialize(QAction *action) { Data *data = new Data(action); ActionType type = action->isSeparator() ? ActionTypeSeparator : ActionTypeNormal; ActionInfo info = { data->id.constData(), data->name.data(), data->description.data(), data->iconPath.data(), type, data }; return info; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アイコンを表示するには、一時ファイルの独自の実装を作成する必要がありました。QTemporaryFileはファイルを独占的に所有しているため、私たちにはあまり適していません。 個別に検討するつもりはありません。すべてが非常にシンプルで明確です。

試練番号2-jumpListsの生成

ジャンプリストを入力するには、beginListメソッドを呼び出す必要があります

 void JumpListsManager::beginList() { if (m_destList) return; ICustomDestinationList *list; HRESULT res = CoCreateInstance(CLSID_DestinationList, 0, CLSCTX_INPROC_SERVER, IID_ICustomDestinationList, (void**)&list); if (FAILED(res)) { return; } UINT maxSlots; m_destList = list; m_destList->SetAppID(m_appId); m_destList->BeginList(&maxSlots, IID_IObjectArray, (void**)&m_destListContent); m_destListContent->Release(); IObjectArray *objArray; CoCreateInstance(CLSID_EnumerableObjectCollection, 0, CLSCTX_INPROC_SERVER, IID_IObjectArray, (void**)&objArray); objArray->QueryInterface(IID_IObjectCollection, (void**)&m_destListContent); objArray->Release(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、このリストに記入します

 void JumpListsManager::addTask(ActionInfo *info) { if (!m_destList) return; IShellLinkW *task; HRESULT res = CoCreateInstance(CLSID_ShellLink, 0, CLSCTX_INPROC_SERVER, IID_IShellLinkW, (void**)&task); if (FAILED(res)) return; task->SetDescription(info->description); task->SetPath(L"rundll32.exe"); task->SetArguments(makeArgs(info).c_str()); if (info->iconPath) task->SetIconLocation(info->iconPath, 0); IPropertyStore *title; PROPVARIANT titlepv; res = task->QueryInterface(IID_IPropertyStore, (void**)&title); if (FAILED(res)) { task->Release(); return; } InitPropVariantFromString(info->name, &titlepv); title->SetValue(PKEY_Title, titlepv); title->Commit(); PropVariantClear(&titlepv); res = m_destListContent->AddObject(task); title->Release(); task->Release(); m_actionInfoMap.insert(std::make_pair(info->id, info)); //    :      id    . } ... void JumpListsManager::addSeparator() { IShellLinkW *separator; IPropertyStore *propStore; PROPVARIANT pv; HRESULT res = CoCreateInstance(CLSID_ShellLink, 0, CLSCTX_INPROC_SERVER, IID_IShellLinkW, (void**)&separator); if (FAILED(res)) return; res = separator->QueryInterface(IID_IPropertyStore, (void**)&propStore); if (FAILED(res)) { separator->Release(); return; } InitPropVariantFromBoolean(TRUE, &pv); propStore->SetValue(PKEY_AppUserModel_IsDestListSeparator, pv); PropVariantClear(&pv); propStore->Commit(); propStore->Release(); res = m_destListContent->AddObject(separator); separator->Release(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、commitListメソッドを呼び出します

 void JumpListsManager::commitList() { if (!m_destList) return; m_destList->AddUserTasks(m_destListContent); m_destList->CommitList(); m_destList->Release(); m_destListContent->Release(); m_destList = 0; m_destListContent = 0; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

冗長、見つかりませんか？ しかし、悲しいかな、あなたは弾丸をかみ、何百行ものコードを走り書きし続けなければなりません。さもなければ何も機能しませんが、私たちは本当の男性であり、困難を恐れていませんか？ そして、恐れないのであれば、コールバックを実装しましょう！

試練番号3-コールバックの実装

では、何がありますか？ jumpListでアイテムをアクティブにすると、引数のセットを使用してコマンドが呼び出されます。 しかし、特定のIDを持つactionInfoを見つけてコールバックを作成したいということをどのように伝えることができますか？

Dtfと私はこれについて長い間考えていましたが、彼はrundllを使用してすべてを実行することを提案しました。rundllは、指定された引数でライブラリから特定のメソッドを呼び出すことができます。

その結果、アクションIDを取得し、ポート42042でソケットを開き、受信したIDをそれに渡すメソッドが生まれました。ライブラリはこのソケットをリッスンし、IDを受信すると、冷静にコールバックを行い、目的のQActionが呼び出されます！

 std::wstring JumpListsManager::makeArgs(ActionInfo *info) { std::wstring args = m_wrapperPath; #ifdef _WIN64 args += L",_RundllCallback@28 "; // WARNING: TEST ME! // ptr×3 + int #else args += L",_RundllCallback@16 "; #endif // Convert to a wchar_t* size_t origsize = strlen(info->id) + 1; const size_t newsize = 64; size_t convertedChars = 0; wchar_t buffer[newsize]; mbstowcs_s(&convertedChars, buffer, origsize, info->id, _TRUNCATE); args += buffer; return args; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最後の方法：rundllが呼び出す関数を実装する

 EXPORT void CALLBACK RundllCallback(HWND hwnd, HINSTANCE hinst, LPSTR cmdLine, int cmdShow); void CALLBACK RundllCallback(HWND, HINSTANCE, LPSTR cmdLine, int) { WSADATA wsaData; WSAStartup(MAKEWORD(2, 2), &wsaData); SOCKET sk; sk = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); if (sk == INVALID_SOCKET) { WSACleanup(); return; } sockaddr_in sai; sai.sin_family = AF_INET; sai.sin_addr.s_addr = inet_addr("127.0.0.1"); sai.sin_port = htons(Handler::port); if (connect(sk, reinterpret_cast<SOCKADDR*>(&sai), sizeof(sai)) == SOCKET_ERROR) { WSACleanup(); return; } std::string cmd = cmdLine; send(sk, cmd.c_str(), cmd.size(), 0); closesocket(sk); WSACleanup(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

それだけです。今日に十分なコードがあります。簡単に呼吸できます。要約しましょう。

Windows実装の制限

1. バッジには2つのバッジのみ
2. 操作の結果、ジャンプリストの最後のファイルは失われます。
3. アクションはサポートされていません-スイッチと非アクティブなアクション
4. サブメニューはサポートされていません

スクリーンショット：

おわりに

ライブラリは非常に使いやすく、拡張も簡単です。 これまでのところ、すべてのプラットフォームにある基本的な機能のみをカバーしています。 将来的には、プラットフォーム固有の拡張機能を追加する方法を検討します。

メニューが問題なくドックにエクスポートされることを保証するには、次の点を満たしている必要があります。

• サブメニューはありません
• 切り替え可能なアイテムまたは無効なアイテムはありません
• 少数のポイントがあるはずです
• setMenuで設定された後は変更しないでください

そしていくつかのコメント：

• ドックの正しい作業は、単一のアプリケーションの場合にのみ可能です。ドックをQtシングルアプリケーションまたは他の同様の手段と組み合わせて使用​​します
• バッジでは、100未満の正の数を使用することをお勧めします

その他の場合、すべてのプラットフォームで何かが利用できるとは限りません。 原則として、これは致命的ではありませんが、これを覚えておく必要があります！

Unityプラグインの実装を支援してくれたTorkve 、Windowsプラグインの実装を支援してくれたdtf 、Macos Xバージョンの実装を支援してくれたQtCreator開発者に感謝します。

ソースコードはgithubで入手できます。 修正と改善を歓迎します。

脅威

Dockmanager APIを実装したい人はいますか？