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