git.sesse.net Git - vlc/blob - modules/gui/qt4/components/complete_preferences.cpp

   1 /*****************************************************************************
   2  * preferences.cpp : "Normal preferences"
   3  ****************************************************************************
   4  * Copyright (C) 2006-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include <QApplication>
  25 #include <QLabel>
  26 #include <QTreeWidget>
  27 #include <QTreeWidgetItem>
  28 #include <QVariant>
  29 #include <QString>
  30 #include <QFont>
  31 #include <QGroupBox>
  32 #include <QScrollArea>
  33 #include <QVBoxLayout>
  34 #include <QHBoxLayout>
  35 #include <QGridLayout>
  36 #include <QHeaderView>
  37 #include <QPalette>
  38 #include <QColor>
  39
  40 #include "components/complete_preferences.hpp"
  41 #include "components/preferences_widgets.hpp"
  42 #include "qt4.hpp"
  43
  44 #include <vlc_config_cat.h>
  45 #include <vlc_intf_strings.h>
  46 #include <assert.h>
  47
  48 #define ITEM_HEIGHT 25
  49
  50 /*********************************************************************
  51  * The Tree
  52  *********************************************************************/
  53 PrefsTree::PrefsTree( intf_thread_t *_p_intf, QWidget *_parent ) :
  54                             QTreeWidget( _parent ), p_intf( _p_intf )
  55 {
  56     setColumnCount( 1 );
  57     setAlternatingRowColors( true );
  58     header()->hide();
  59     setIconSize( QSize( ITEM_HEIGHT,ITEM_HEIGHT ) );
  60     setTextElideMode( Qt::ElideNone );
  61     setHorizontalScrollBarPolicy ( Qt::ScrollBarAlwaysOn );
  62
  63 #define BI( a,b) QIcon a##_icon = QIcon( QPixmap( b ))
  64     BI( audio, ":/pixmaps/vlc_advprefs_audio.png" );
  65     BI( video, ":/pixmaps/vlc_advprefs_video.png" );
  66     BI( input, ":/pixmaps/vlc_advprefs_codec.png" );
  67     BI( sout, ":/pixmaps/vlc_advprefs_sout.png" );
  68     BI( advanced, ":/pixmaps/vlc_advprefs_extended.png" );
  69     BI( playlist, ":/pixmaps/vlc_advprefs_playlist.png" );
  70     BI( interface, ":/pixmaps/vlc_advprefs_intf.png" );
  71 #undef BI
  72
  73     /* Build the tree for the main module */
  74     const module_t *p_module = NULL;
  75     vlc_list_t *p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE,
  76                                         FIND_ANYWHERE );
  77     if( !p_list ) return;
  78     for( unsigned i = 0; p_module == NULL; i++ )
  79     {
  80         assert (i < (unsigned)p_list->i_count);
  81
  82         const module_t *p_main = (module_t *)p_list->p_values[i].p_object;
  83         if( strcmp( module_GetObjName( p_main ), "main" ) == 0 )
  84             p_module = p_main;
  85     }
  86
  87     PrefsItemData *data = NULL;
  88     QTreeWidgetItem *current_item = NULL;
  89     for (size_t i = 0; i < p_module->confsize; i++)
  90     {
  91         const module_config_t *p_item = p_module->p_config + i;
  92         const char *psz_help;
  93         QIcon icon;
  94         switch( p_item->i_type )
  95         {
  96         case CONFIG_CATEGORY:
  97             if( p_item->value.i == -1 ) break;
  98             data = new PrefsItemData();
  99             data->name = QString( qtr( config_CategoryNameGet
 100                                            ( p_item->value.i ) ) );
 101             psz_help = config_CategoryHelpGet( p_item->value.i );
 102             if( psz_help )
 103                 data->help = QString( qtr(psz_help) );
 104             else
 105                 data->help.clear();
 106             data->i_type = TYPE_CATEGORY;
 107             data->i_object_id = p_item->value.i;
 108
 109             switch( p_item->value.i )
 110             {
 111 #define CI(a,b) case a: icon = b##_icon;break
 112             CI( CAT_AUDIO, audio );
 113             CI( CAT_VIDEO, video );
 114             CI( CAT_INPUT, input );
 115             CI( CAT_SOUT, sout );
 116             CI( CAT_ADVANCED, advanced );
 117             CI( CAT_PLAYLIST, playlist );
 118             CI( CAT_INTERFACE, interface );
 119 #undef CI
 120             }
 121
 122             current_item = new QTreeWidgetItem();
 123             current_item->setText( 0, data->name );
 124             current_item->setIcon( 0 , icon );
 125             current_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 126             current_item->setData( 0, Qt::UserRole,
 127                                    qVariantFromValue( data ) );
 128             addTopLevelItem( current_item );
 129             break;
 130         case CONFIG_SUBCATEGORY:
 131             if( p_item->value.i == -1 ) break;
 132             if( data &&
 133                 ( p_item->value.i == SUBCAT_VIDEO_GENERAL ||
 134                   p_item->value.i == SUBCAT_ADVANCED_MISC ||
 135                   p_item->value.i == SUBCAT_INPUT_GENERAL ||
 136                   p_item->value.i == SUBCAT_INTERFACE_GENERAL ||
 137                   p_item->value.i == SUBCAT_SOUT_GENERAL||
 138                   p_item->value.i == SUBCAT_PLAYLIST_GENERAL||
 139                   p_item->value.i == SUBCAT_AUDIO_GENERAL ) )
 140             {
 141                 // Data still contains the correct thing
 142                 data->i_type = TYPE_CATSUBCAT;
 143                 data->i_subcat_id = p_item->value.i;
 144                 data->name = QString( qtr( config_CategoryNameGet(
 145                                             p_item->value.i )) );
 146                 psz_help = config_CategoryHelpGet( p_item->value.i );
 147                 if( psz_help )
 148                     data->help = QString( qtr(psz_help) );
 149                 else
 150                     data->help.clear();
 151                 current_item->setData( 0, Qt::UserRole,
 152                                        QVariant::fromValue( data ) );
 153                 continue;
 154             }
 155             data = new PrefsItemData();
 156             data->name = QString( qtr( config_CategoryNameGet(
 157                                                         p_item->value.i)) );
 158             psz_help = config_CategoryHelpGet( p_item->value.i );
 159             if( psz_help )
 160                 data->help = QString( qtr(psz_help) );
 161             else
 162                 data->help.clear();
 163             data->i_type = TYPE_SUBCATEGORY;
 164             data->i_object_id = p_item->value.i;
 165
 166             assert( current_item );
 167
 168             /* TODO : Choose the image */
 169             QTreeWidgetItem *subcat_item = new QTreeWidgetItem();
 170             subcat_item->setText( 0, data->name );
 171             //item->setIcon( 0 , XXX );
 172             subcat_item->setData( 0, Qt::UserRole,
 173                                   qVariantFromValue(data) );
 174             subcat_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 175             current_item->addChild( subcat_item );
 176             break;
 177         }
 178     }
 179
 180     /* Build the tree of plugins */
 181     for( int i_index = 0; i_index < p_list->i_count; i_index++ )
 182     {
 183         p_module = (module_t *)p_list->p_values[i_index].p_object;
 184
 185         // Main module excluded
 186         if( !strcmp( module_GetObjName( p_module ), "main" ) ) continue;
 187
 188         /* Exclude submodules; they have no config options of their own */
 189         if( p_module->b_submodule ) continue;
 190
 191         unsigned i_subcategory = 0, i_category = 0;
 192         bool b_options = false;
 193
 194         for (size_t i = 0; i < p_module->confsize; i++)
 195         {
 196             const module_config_t *p_item = p_module->p_config + i;
 197
 198             if( p_item->i_type == CONFIG_CATEGORY )
 199                 i_category = p_item->value.i;
 200             else if( p_item->i_type == CONFIG_SUBCATEGORY )
 201                 i_subcategory = p_item->value.i;
 202
 203             if( p_item->i_type & CONFIG_ITEM )
 204                 b_options = true;
 205
 206             if( b_options && i_category && i_subcategory )
 207                 break;
 208         }
 209         if( !b_options || i_category == 0 || i_subcategory == 0 ) continue;
 210
 211         // Locate the category item;
 212         QTreeWidgetItem *subcat_item = NULL;
 213         bool b_found = false;
 214         for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 215                                    i_cat_index++ )
 216         {
 217             QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 218             PrefsItemData *data = cat_item->data( 0, Qt::UserRole ).
 219                                              value<PrefsItemData *>();
 220             if( data->i_object_id == i_category )
 221             {
 222                 for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 223                          i_sc_index++ )
 224                 {
 225                     subcat_item = cat_item->child( i_sc_index );
 226                     PrefsItemData *sc_data = subcat_item->data(0, Qt::UserRole).
 227                                                 value<PrefsItemData *>();
 228                     if( sc_data && sc_data->i_object_id == i_subcategory )
 229                     {
 230                         b_found = true;
 231                         break;
 232                     }
 233                 }
 234                 if( !b_found )
 235                 {
 236                     subcat_item = cat_item;
 237                     b_found = true;
 238                 }
 239                 break;
 240             }
 241         }
 242         if( !b_found ) continue;
 243
 244         PrefsItemData *module_data = new PrefsItemData();
 245         module_data->b_submodule = p_module->b_submodule;
 246         module_data->i_type = TYPE_MODULE;
 247         module_data->psz_name = strdup( module_GetObjName( p_module ) );
 248         module_data->i_object_id = p_module->b_submodule ?
 249                          ((module_t *)p_module->p_parent)->i_object_id :
 250                          p_module->i_object_id;
 251         module_data->help.clear();
 252         // TODO image
 253         QTreeWidgetItem *module_item = new QTreeWidgetItem();
 254         module_item->setText( 0, qtr( module_GetName( p_module, VLC_FALSE ) ) );
 255         //item->setIcon( 0 , XXX );
 256         module_item->setData( 0, Qt::UserRole,
 257                               QVariant::fromValue( module_data) );
 258         module_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 259         subcat_item->addChild( module_item );
 260     }
 261
 262     /* We got everything, just sort a bit */
 263     sortItems( 0, Qt::AscendingOrder );
 264
 265     vlc_list_release( p_list );
 266 }
 267
 268 PrefsTree::~PrefsTree() {}
 269
 270 void PrefsTree::applyAll()
 271 {
 272     doAll( false );
 273 }
 274
 275 void PrefsTree::cleanAll()
 276 {
 277     doAll( true );
 278 }
 279
 280 void PrefsTree::doAll( bool doclean )
 281 {
 282     for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 283              i_cat_index++ )
 284     {
 285         QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 286         for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 287                  i_sc_index++ )
 288         {
 289             QTreeWidgetItem *sc_item = cat_item->child( i_sc_index );
 290             for( int i_module = 0 ; i_module < sc_item->childCount();
 291                      i_module++ )
 292             {
 293                 PrefsItemData *data = sc_item->child( i_module )->
 294                                data( 0, Qt::UserRole).value<PrefsItemData *>();
 295                 if( data->panel && doclean )
 296                 {
 297                     delete data->panel;
 298                     data->panel = NULL;
 299                 }
 300                 else if( data->panel )
 301                     data->panel->apply();
 302             }
 303             PrefsItemData *data = sc_item->data( 0, Qt::UserRole).
 304                                             value<PrefsItemData *>();
 305             if( data->panel && doclean )
 306             {
 307                 delete data->panel;
 308                 data->panel = NULL;
 309             }
 310             else if( data->panel )
 311                 data->panel->apply();
 312         }
 313         PrefsItemData *data = cat_item->data( 0, Qt::UserRole).
 314                                             value<PrefsItemData *>();
 315         if( data->panel && doclean )
 316         {
 317             delete data->panel;
 318             data->panel = NULL;
 319         }
 320         else if( data->panel )
 321             data->panel->apply();
 322     }
 323 }
 324
 325 /*********************************************************************
 326  * The Panel
 327  *********************************************************************/
 328 PrefsPanel::PrefsPanel( QWidget *_parent ) : QWidget( _parent )
 329 {}
 330
 331 PrefsPanel::PrefsPanel( intf_thread_t *_p_intf, QWidget *_parent,
 332                         PrefsItemData * data ) :
 333                         QWidget( _parent ), p_intf( _p_intf )
 334 {
 335     /* Find our module */
 336     module_t *p_module = NULL;
 337     if( data->i_type == TYPE_CATEGORY )
 338         return;
 339     else if( data->i_type == TYPE_MODULE )
 340         p_module = (module_t *) vlc_object_get( p_intf, data->i_object_id );
 341     else
 342     {
 343         p_module = config_FindModule( VLC_OBJECT(p_intf), "main" );
 344         assert( p_module );
 345         vlc_object_yield( p_module );
 346     }
 347
 348     module_t *p_realmodule = p_module->b_submodule
 349             ? (module_t *)(p_module->p_parent)
 350             : p_module;
 351
 352     module_config_t *p_item = p_realmodule->p_config;
 353     module_config_t *p_end = p_item + p_realmodule->confsize;
 354
 355     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 356     {
 357         while (p_item < p_end)
 358         {
 359             if( p_item->i_type == CONFIG_SUBCATEGORY &&
 360                             ( data->i_type == TYPE_SUBCATEGORY &&
 361                               p_item->value.i == data->i_object_id ) ||
 362                             ( data->i_type == TYPE_CATSUBCAT &&
 363                               p_item->value.i == data->i_subcat_id ) )
 364                 break;
 365             p_item++;
 366         }
 367     }
 368
 369     /* Widgets now */
 370     global_layout = new QVBoxLayout();
 371     global_layout->setMargin( 2 );
 372     QString head;
 373     QString help;
 374
 375     help = QString( data->help );
 376
 377     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 378     {
 379         head = QString( data->name );
 380         p_item++; // Why that ?
 381     }
 382     else
 383     {
 384         head = QString( qtr( module_GetLongName( p_module ) ) );
 385         if( p_module->psz_help )
 386         {
 387             help.append( "\n" );
 388             help.append( qtr( module_GetHelp( p_module ) ) );
 389         }
 390     }
 391
 392     QLabel *titleLabel = new QLabel( head );
 393     QFont titleFont = QApplication::font( static_cast<QWidget*>(0) );
 394     titleFont.setPointSize( titleFont.pointSize() + 6 );
 395     titleFont.setFamily( "Verdana" );
 396     titleLabel->setFont( titleFont );
 397
 398     // Title <hr>
 399     QFrame *title_line = new QFrame;
 400     title_line->setFrameShape(QFrame::HLine);
 401     title_line->setFrameShadow(QFrame::Sunken);
 402
 403     QLabel *helpLabel = new QLabel( help, this );
 404     helpLabel->setWordWrap( true );
 405
 406     global_layout->addWidget( titleLabel );
 407     global_layout->addWidget( title_line );
 408     global_layout->addWidget( helpLabel );
 409
 410     QGroupBox *box = NULL;
 411     QGridLayout *boxlayout = NULL;
 412
 413     QScrollArea *scroller= new QScrollArea;
 414     scroller->setFrameStyle( QFrame::NoFrame );
 415     QWidget *scrolled_area = new QWidget;
 416
 417     QGridLayout *layout = new QGridLayout();
 418     int i_line = 0, i_boxline = 0;
 419     bool has_hotkey = false;
 420
 421     if( p_item ) do
 422     {
 423         if( ( ( data->i_type == TYPE_SUBCATEGORY &&
 424                 p_item->value.i != data->i_object_id ) ||
 425               ( data->i_type == TYPE_CATSUBCAT  &&
 426                 p_item->value.i != data->i_subcat_id ) ) &&
 427             ( p_item->i_type == CONFIG_CATEGORY ||
 428               p_item->i_type == CONFIG_SUBCATEGORY ) )
 429             break;
 430         if( p_item->b_internal == VLC_TRUE ) continue;
 431
 432         if( p_item->i_type == CONFIG_SECTION )
 433         {
 434             if( box )
 435             {
 436                 box->setLayout( boxlayout );
 437                 layout->addWidget( box, i_line, 0, 1, 2 );
 438                 i_line++;
 439             }
 440             box = new QGroupBox( qtr(p_item->psz_text) );
 441             boxlayout = new QGridLayout();
 442         }
 443         /* Only one hotkey control */
 444         if( has_hotkey && p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 445                                          strstr( p_item->psz_name, "key-" ) )
 446             continue;
 447         if( p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 448                                             strstr( p_item->psz_name, "key-" ) )
 449             has_hotkey = true;
 450
 451         ConfigControl *control;
 452         if( ! box )
 453             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 454                                         p_item, NULL, layout, i_line );
 455         else
 456             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 457                                     p_item, NULL, boxlayout, i_boxline );
 458         if( !control )
 459             continue;
 460
 461         if( has_hotkey )
 462         {
 463             /* A hotkey widget takes 2 lines */
 464             if( box ) i_boxline ++;
 465             else i_line++;
 466         }
 467
 468         if( box ) i_boxline++;
 469         else i_line++;
 470         controls.append( control );
 471     }
 472     while( !( ( data->i_type == TYPE_SUBCATEGORY ||
 473                data->i_type == TYPE_CATSUBCAT ) &&
 474              ( p_item->i_type == CONFIG_CATEGORY ||
 475                p_item->i_type == CONFIG_SUBCATEGORY ) )
 476         && ( ++p_item < p_end ) );
 477
 478     if( box )
 479     {
 480         box->setLayout( boxlayout );
 481         layout->addWidget( box, i_line, 0, 1, 2 );
 482     }
 483
 484     vlc_object_release( p_module );
 485
 486     scrolled_area->setSizePolicy( QSizePolicy::Preferred,QSizePolicy::Fixed );
 487     scrolled_area->setLayout( layout );
 488     scroller->setWidget( scrolled_area );
 489     scroller->setWidgetResizable( true );
 490     global_layout->addWidget( scroller );
 491     setLayout( global_layout );
 492 }
 493
 494 void PrefsPanel::apply()
 495 {
 496     QList<ConfigControl *>::Iterator i;
 497     for( i = controls.begin() ; i != controls.end() ; i++ )
 498     {
 499         ConfigControl *c = qobject_cast<ConfigControl *>(*i);
 500         c->doApply( p_intf );
 501     }
 502 }
 503 void PrefsPanel::clean()
 504 {}